<!DOCTYPE html><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Dimble's Playground » \Rights</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Dimble's Playground</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Auth.html"><i class="icon-folder-open"></i> Auth</a></li>
<li><a href="../packages/Database.html"><i class="icon-folder-open"></i> Database</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Infraestructure.html"><i class="icon-folder-open"></i> Infraestructure</a></li>
<li><a href="../packages/Rights.html"><i class="icon-folder-open"></i> Rights</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">418</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<div class="btn-toolbar">
<div class="btn-group visibility" data-toggle="buttons-checkbox">
<button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button>
</div>
<div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i title="Methods" class="icon-custom icon-method"></i> Methods
                    <ul>
<li class="method public "><a href="#method_assign" title="assign() :: Assigns an authorization item to a specific user."><span class="description">Assigns an authorization item to a specific user.</span><pre>assign()</pre></a></li>
<li class="method public "><a href="#method_getAssignedRoles" title="getAssignedRoles() :: Returns the roles assigned to a specific user."><span class="description">Returns the roles assigned to a specific user.</span><pre>getAssignedRoles()</pre></a></li>
<li class="method public "><a href="#method_getAuthItemOptions" title="getAuthItemOptions() :: Returns the list of authorization item types."><span class="description">Returns the list of authorization item types.</span><pre>getAuthItemOptions()</pre></a></li>
<li class="method public "><a href="#method_getAuthItemRoute" title="getAuthItemRoute() :: Returns the route to a specific authorization item list view."><span class="description">Returns the route to a specific authorization item list view.</span><pre>getAuthItemRoute()</pre></a></li>
<li class="method public "><a href="#method_getAuthItemSelectOptions" title="getAuthItemSelectOptions() :: Returns the authorization item select options."><span class="description">Returns the authorization item select options.</span><pre>getAuthItemSelectOptions()</pre></a></li>
<li class="method public "><a href="#method_getAuthItemTypeName" title="getAuthItemTypeName() :: Returns the name of a specific authorization item."><span class="description">Returns the name of a specific authorization item.</span><pre>getAuthItemTypeName()</pre></a></li>
<li class="method public "><a href="#method_getAuthItemTypeNamePlural" title="getAuthItemTypeNamePlural() :: Returns the name of a specific authorization item in plural."><span class="description">Returns the name of a specific authorization item in plural.</span><pre>getAuthItemTypeNamePlural()</pre></a></li>
<li class="method public "><a href="#method_getAuthorizer" title="getAuthorizer() :: "><span class="description">getAuthorizer()
        </span><pre>getAuthorizer()</pre></a></li>
<li class="method public "><a href="#method_getBaseUrl" title="getBaseUrl() :: Returns the base url to Rights."><span class="description">Returns the base url to Rights.</span><pre>getBaseUrl()</pre></a></li>
<li class="method public "><a href="#method_getCsrfParam" title="getCsrfParam() :: Returns the cross-site request forgery parameter for Ajax-requests."><span class="description">Returns the cross-site request forgery parameter for Ajax-requests.</span><pre>getCsrfParam()</pre></a></li>
<li class="method public "><a href="#method_getDataCsrf" title="getDataCsrf() :: Returns the cross-site request forgery parameter
to be placed in the data of Ajax-requests."><span class="description">Returns the cross-site request forgery parameter
to be placed in the data of Ajax-requests.</span><pre>getDataCsrf()</pre></a></li>
<li class="method public "><a href="#method_getParentAuthItemSelectOptions" title="getParentAuthItemSelectOptions() :: Returns the valid authorization item select options for a model."><span class="description">Returns the valid authorization item select options for a model.</span><pre>getParentAuthItemSelectOptions()</pre></a></li>
<li class="method public "><a href="#method_getValidChildTypes" title="getValidChildTypes() :: Returns the valid child item types for a specific type."><span class="description">Returns the valid child item types for a specific type.</span><pre>getValidChildTypes()</pre></a></li>
<li class="method public "><a href="#method_module" title="module() :: "><span class="description">module()
        </span><pre>module()</pre></a></li>
<li class="method public "><a href="#method_powered" title="powered() :: "><span class="description">powered()
        </span><pre>powered()</pre></a></li>
<li class="method public "><a href="#method_revoke" title="revoke() :: Revokes an authorization item from a specific user."><span class="description">Revokes an authorization item from a specific user.</span><pre>revoke()</pre></a></li>
<li class="method public "><a href="#method_t" title="t() :: Translates a message to the specified language."><span class="description">Translates a message to the specified language.</span><pre>t()</pre></a></li>
</ul>
</li>
<li class="nav-header protected">» Protected
                    <ul><li class="method protected "><a href="#method_generateAuthItemSelectOptions" title="generateAuthItemSelectOptions() :: Generates the authorization item select options."><span class="description">Generates the authorization item select options.</span><pre>generateAuthItemSelectOptions()</pre></a></li></ul>
</li>
<li class="nav-header private">» Private
                    <ul><li class="method private "><a href="#method_findModule" title="findModule() :: Searches for the Rights module among all installed modules."><span class="description">Searches for the Rights module among all installed modules.</span><pre>findModule()</pre></a></li></ul>
</li>
<li class="nav-header">
<i title="Properties" class="icon-custom icon-property"></i> Properties
                    <ul></ul>
</li>
<li class="nav-header private">» Private
                    <ul>
<li class="property private "><a href="#property__a" title="$_a() :: "><span class="description"></span><pre>$_a</pre></a></li>
<li class="property private "><a href="#property__m" title="$_m() :: "><span class="description"></span><pre>$_m</pre></a></li>
</ul>
</li>
<li class="nav-header">
<i title="Constants" class="icon-custom icon-constant"></i> Constants
                    <ul>
<li class="constant  "><a href="#constant_PERM_DIRECT" title="PERM_DIRECT() :: "><span class="description">PERM_DIRECT</span><pre>PERM_DIRECT</pre></a></li>
<li class="constant  "><a href="#constant_PERM_INHERITED" title="PERM_INHERITED() :: "><span class="description">PERM_INHERITED</span><pre>PERM_INHERITED</pre></a></li>
<li class="constant  "><a href="#constant_PERM_NONE" title="PERM_NONE() :: "><span class="description">PERM_NONE</span><pre>PERM_NONE</pre></a></li>
</ul>
</li>
</ul>
</div>
<div class="span8">
<a id="\Rights"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/Rights.html">Rights</a>
</li>
</ul>
<div class="element class">
<p class="short_description">Rights helper class file.</p>
<div class="details">
<div class="long_description">Provides static functions for interaction with Rights from outside of the module.</div>
<table class="table table-bordered">
<tr>
<th>author</th>
<td><a href="mailto:cniska@live.com">Christoffer Niska</a></td>
</tr>
<tr>
<th>copyright</th>
<td>Copyright &amp;copy; 2010 Christoffer Niska</td>
</tr>
<tr>
<th>since</th>
<td>0.9.1</td>
</tr>
<tr>
<th>package</th>
<td><a href="../packages/Rights.html">Rights</a></td>
</tr>
</table>
<h3>
<i title="Methods" class="icon-custom icon-method"></i> Methods</h3>
<a id="method_assign"></a><div class="element clickable method public method_assign" data-toggle="collapse" data-target=".method_assign .collapse" title="public">
<h2>Assigns an authorization item to a specific user.</h2>
<pre>assign(string $itemName, integer $userId, string $bizRule<code> = null</code>, mixed $data<code> = null</code>) : <a href="CAuthItem.html">\CAuthItem</a></pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$itemName</h4>
<code>string</code><p>the name of the item to assign.</p></div>
<div class="subelement argument">
<h4>$userId</h4>
<code>integer</code><p>the user id of the user for which to assign the item.</p></div>
<div class="subelement argument">
<h4>$bizRule</h4>
<code>string</code><p>business rule associated with the item. This is a piece of
PHP code that will be executed when {@link checkAccess} is called for the item.</p></div>
<div class="subelement argument">
<h4>$data</h4>
<code>mixed</code><p>additional data associated with the item.</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="CAuthItem.html">\CAuthItem</a></code>the authorization item</div>
</div></div>
</div>
<a id="method_getAssignedRoles"></a><div class="element clickable method public method_getAssignedRoles" data-toggle="collapse" data-target=".method_getAssignedRoles .collapse" title="public">
<h2>Returns the roles assigned to a specific user.</h2>
<pre>getAssignedRoles(integer $userId<code> = null</code>, boolean $sort<code> = true</code>) : array</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description">If no user id is provided the logged in user will be used.</div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$userId</h4>
<code>integer</code><p>the user id of the user for which roles to get.</p></div>
<div class="subelement argument">
<h4>$sort</h4>
<code>boolean</code><p>whether to sort the items by their weights.</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>the roles.</div>
</div></div>
</div>
<a id="method_getAuthItemOptions"></a><div class="element clickable method public method_getAuthItemOptions" data-toggle="collapse" data-target=".method_getAuthItemOptions .collapse" title="public">
<h2>Returns the list of authorization item types.</h2>
<pre>getAuthItemOptions() : array</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>the list of types.</div>
</div></div>
</div>
<a id="method_getAuthItemRoute"></a><div class="element clickable method public method_getAuthItemRoute" data-toggle="collapse" data-target=".method_getAuthItemRoute .collapse" title="public">
<h2>Returns the route to a specific authorization item list view.</h2>
<pre>getAuthItemRoute(integer $type) : array</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$type</h4>
<code>integer</code><p>the item type (0: operation, 1: task, 2: role).</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>the route.</div>
</div></div>
</div>
<a id="method_getAuthItemSelectOptions"></a><div class="element clickable method public method_getAuthItemSelectOptions" data-toggle="collapse" data-target=".method_getAuthItemSelectOptions .collapse" title="public">
<h2>Returns the authorization item select options.</h2>
<pre>getAuthItemSelectOptions(mixed $type<code> = null</code>, array $exclude<code> = array()</code>) : array</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$type</h4>
<code>mixed</code><p>the item type (0: operation, 1: task, 2: role). Defaults to null,
meaning returning all items regardless of their type.</p></div>
<div class="subelement argument">
<h4>$exclude</h4>
<code>array</code><p>the items to be excluded.</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>the select options.</div>
</div></div>
</div>
<a id="method_getAuthItemTypeName"></a><div class="element clickable method public method_getAuthItemTypeName" data-toggle="collapse" data-target=".method_getAuthItemTypeName .collapse" title="public">
<h2>Returns the name of a specific authorization item.</h2>
<pre>getAuthItemTypeName(integer $type) : string</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$type</h4>
<code>integer</code><p>the item type (0: operation, 1: task, 2: role).</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>the authorization item type name.</div>
</div></div>
</div>
<a id="method_getAuthItemTypeNamePlural"></a><div class="element clickable method public method_getAuthItemTypeNamePlural" data-toggle="collapse" data-target=".method_getAuthItemTypeNamePlural .collapse" title="public">
<h2>Returns the name of a specific authorization item in plural.</h2>
<pre>getAuthItemTypeNamePlural(integer $type) : string</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$type</h4>
<code>integer</code><p>the item type (0: operation, 1: task, 2: role).</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>the authorization item type name.</div>
</div></div>
</div>
<a id="method_getAuthorizer"></a><div class="element clickable method public method_getAuthorizer" data-toggle="collapse" data-target=".method_getAuthorizer .collapse" title="public">
<h2>getAuthorizer()
        </h2>
<pre>getAuthorizer() : <a href="../classes/RAuthorizer.html">\RAuthorizer</a></pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="../classes/RAuthorizer.html">\RAuthorizer</a></code>the authorizer component.</div>
</div></div>
</div>
<a id="method_getBaseUrl"></a><div class="element clickable method public method_getBaseUrl" data-toggle="collapse" data-target=".method_getBaseUrl .collapse" title="public">
<h2>Returns the base url to Rights.</h2>
<pre>getBaseUrl() : <a href="the.html">\the</a></pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="the.html">\the</a></code>url to Rights.</div>
</div></div>
</div>
<a id="method_getCsrfParam"></a><div class="element clickable method public method_getCsrfParam" data-toggle="collapse" data-target=".method_getCsrfParam .collapse" title="public">
<h2>Returns the cross-site request forgery parameter for Ajax-requests.</h2>
<pre>getCsrfParam() : string</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description">Null is returned if csrf-validation is disabled.</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>the csrf parameter.</div>
</div></div>
</div>
<a id="method_getDataCsrf"></a><div class="element clickable method public method_getDataCsrf" data-toggle="collapse" data-target=".method_getDataCsrf .collapse" title="public">
<h2>Returns the cross-site request forgery parameter
to be placed in the data of Ajax-requests.</h2>
<pre>getDataCsrf() : string</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description">An empty string is returned if csrf-validation is disabled.</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>the csrf parameter.</div>
</div></div>
</div>
<a id="method_getParentAuthItemSelectOptions"></a><div class="element clickable method public method_getParentAuthItemSelectOptions" data-toggle="collapse" data-target=".method_getParentAuthItemSelectOptions .collapse" title="public">
<h2>Returns the valid authorization item select options for a model.</h2>
<pre>getParentAuthItemSelectOptions(mixed $parent, \CAuthItem $type<code> = null</code>, array $exclude<code> = array()</code>) : array</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$parent</h4>
<code>mixed</code><p>the item type (0: operation, 1: task, 2: role). Defaults to null,
meaning returning all items regardless of their type.</p></div>
<div class="subelement argument">
<h4>$type</h4>
<code><a href="CAuthItem.html">\CAuthItem</a></code><p>the item for which to get the select options.</p></div>
<div class="subelement argument">
<h4>$exclude</h4>
<code>array</code><p>the items to be excluded.</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>the select options.</div>
</div></div>
</div>
<a id="method_getValidChildTypes"></a><div class="element clickable method public method_getValidChildTypes" data-toggle="collapse" data-target=".method_getValidChildTypes .collapse" title="public">
<h2>Returns the valid child item types for a specific type.</h2>
<pre>getValidChildTypes(string $type) : array</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$type</h4>
<code>string</code><p>the item type (0: operation, 1: task, 2: role).</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>the valid types.</div>
</div></div>
</div>
<a id="method_module"></a><div class="element clickable method public method_module" data-toggle="collapse" data-target=".method_module .collapse" title="public">
<h2>module()
        </h2>
<pre>module() : <a href="../classes/RightsModule.html">\RightsModule</a></pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="../classes/RightsModule.html">\RightsModule</a></code>the Rights module.</div>
</div></div>
</div>
<a id="method_powered"></a><div class="element clickable method public method_powered" data-toggle="collapse" data-target=".method_powered .collapse" title="public">
<h2>powered()
        </h2>
<pre>powered() : string</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>a string that can be displayed on your Web page
showing Powered-by-Rights information.</div>
</div></div>
</div>
<a id="method_revoke"></a><div class="element clickable method public method_revoke" data-toggle="collapse" data-target=".method_revoke .collapse" title="public">
<h2>Revokes an authorization item from a specific user.</h2>
<pre>revoke(string $itemName, integer $userId) : boolean</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$itemName</h4>
<code>string</code><p>the name of the item to revoke.</p></div>
<div class="subelement argument">
<h4>$userId</h4>
<code>integer</code><p>the user id of the user for which to revoke the item.</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>boolean</code>whether the item was removed.</div>
</div></div>
</div>
<a id="method_t"></a><div class="element clickable method public method_t" data-toggle="collapse" data-target=".method_t .collapse" title="public">
<h2>Translates a message to the specified language.</h2>
<pre>t(string $category, string $message, array $params<code> = array()</code>, string $source<code> = null</code>, string $language<code> = null</code>) : string</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description">Wrapper class for setting the category correctly.</div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$category</h4>
<code>string</code><p>message category.</p></div>
<div class="subelement argument">
<h4>$message</h4>
<code>string</code><p>the original message.</p></div>
<div class="subelement argument">
<h4>$params</h4>
<code>array</code><p>parameters to be applied to the message using <code>strtr</code>.</p></div>
<div class="subelement argument">
<h4>$source</h4>
<code>string</code><p>which message source application component to use.</p></div>
<div class="subelement argument">
<h4>$language</h4>
<code>string</code><p>the target language.</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>the translated message.</div>
</div></div>
</div>
<a id="method_generateAuthItemSelectOptions"></a><div class="element clickable method protected method_generateAuthItemSelectOptions" data-toggle="collapse" data-target=".method_generateAuthItemSelectOptions .collapse" title="protected">
<h2>Generates the authorization item select options.</h2>
<pre>generateAuthItemSelectOptions(array $items, mixed $type) : array</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$items</h4>
<code>array</code><p>the authorization items.</p></div>
<div class="subelement argument">
<h4>$type</h4>
<code>mixed</code><p>the item type (0: operation, 1: task, 2: role).</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>the select options.</div>
</div></div>
</div>
<a id="method_findModule"></a><div class="element clickable method private method_findModule" data-toggle="collapse" data-target=".method_findModule .collapse" title="private">
<h2>Searches for the Rights module among all installed modules.</h2>
<pre>findModule(\CModule $module<code> = null</code>) : <a href="the.html">\the</a></pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description">The module will be found even if it's nested within another module.</div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$module</h4>
<code><a href="CModule.html">\CModule</a></code><p>the module to find the module in. Defaults to null,
meaning that the application will be used.</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="the.html">\the</a></code>Rights module.</div>
</div></div>
</div>
<h3>
<i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
<a id="property__a"> </a><div class="element clickable property private property__a" data-toggle="collapse" data-target=".property__a .collapse" title="private">
<h2>$_a</h2>
<pre>$_a </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property__m"> </a><div class="element clickable property private property__m" data-toggle="collapse" data-target=".property__m .collapse" title="private">
<h2>$_m</h2>
<pre>$_m </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<h3>
<i title="Constants" class="icon-custom icon-constant"></i> Constants</h3>
<a id="constant_PERM_DIRECT"> </a><div class="element clickable constant  constant_PERM_DIRECT" data-toggle="collapse" data-target=".constant_PERM_DIRECT .collapse" title="">
<h2>PERM_DIRECT</h2>
<pre>PERM_DIRECT = 1 </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_PERM_INHERITED"> </a><div class="element clickable constant  constant_PERM_INHERITED" data-toggle="collapse" data-target=".constant_PERM_INHERITED .collapse" title="">
<h2>PERM_INHERITED</h2>
<pre>PERM_INHERITED = 2 </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_PERM_NONE"> </a><div class="element clickable constant  constant_PERM_NONE" data-toggle="collapse" data-target=".constant_PERM_NONE .collapse" title="">
<h2>PERM_NONE</h2>
<pre>PERM_NONE = 0 </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br>
            generated on 2014-02-03T11:03:56-02:00.<br></footer></div>
</div>
</body>
</html>
